home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr49 / 112_01.zip / NRO.DOC < prev    next >
Text File  |  1993-06-19  |  16KB  |  331 lines

  1.  
  2.      NRO (1)                    CP/M Version 2.2                    NRO (1)
  3.  
  4.  
  5.  
  6.      NAME        NAME 
  7.           nro - text processor 
  8.  
  9.      SYNOPSIS        SYNOPSIS 
  10.           nro   n    n    pxx    v    b    mmfile  ifile       ofile              nro [-n] [+n] [-pxx] [-v] [-b] [-mmfile] ifile ... [>ofile] 
  11.  
  12.      DESCRIPTION        DESCRIPTION 
  13.           ___                                                                     NRO  is  a  text processor and formatter based on the design
  14.                         Software Tools                                             provided in  "Software Tools" by Kernighan and Plauger.  The 
  15.                                           ________                                text and commands found in the  ifile(s)  are  processed  to
  16.           generate formatted  text.  The output may be directed into a
  17.                                     _____                                         file or to the printer if ofile is present  in  the  command
  18.           line;   otherwise,  the  output  will  appear  at  the  user
  19.                                                                     P             console.  Directing the output to the special filename,  $P,
  20.           will cause the output to be sent to the printer.  
  21.  
  22.                _                                               _                  The +n  option  causes the output to start with page n.  The
  23.            _                                             _               -n option causes the output to stop after page n.  
  24.  
  25.                _                                                               The -v option prints the version number to the console.  
  26.  
  27.                _                                                                  The -p option causes the output to be shifted to  the  right
  28.              __                                           po                       by xx spaces.  This has the same effect as the .po command.  
  29.  
  30.                _                                                                   The -b option allows backspaces to appear in the output text 
  31.           when underlining  or overstriking.  This has the same effect
  32.                   bs                                                as the .bs command with a non-zero argument.  
  33.  
  34.                 _                                  _____                          The  -m  option  processes  the   file   mfile   for   macro
  35.           definitions.   Note  that files processed in this way should
  36.           contain only macro definitions, no immediate  output  should
  37.           be generated from this file.  
  38.  
  39.           Commands  typically  are distinguished by a period in column
  40.           one of the input followed by a  two  character  abbreviation
  41.           for the  command  funtion.    The  abbreviation  may then be
  42.           followed by an optional numeric or character argument.   The
  43.           numeric  argument  may  be an absolute value such as setting
  44.           the right margin to a particular column, or the argument may 
  45.           be preceded by a plus sign or a minus sign to indicate  that
  46.           the  parameter  should  be  modified  relative to a previous
  47.           setting.  The following commands are recognized: 
  48.  
  49.           .bo - causes the following lines of text to appear in 
  50.                 boldface.  The optional argument specifies the number 
  51.                 of lines to be typed in boldface.  Boldface and 
  52.                 underlining are mutually exclusive features.  The 
  53.                 appearance of a boldface command will cause any 
  54.                 underlining to cease.  
  55.  
  56.           .bp - causes succeeding text to appear at the top of a new 
  57.                 page.  The optional argument specifies the page number 
  58.                 for the new page.  The initial value is one and the 
  59.                 default value is one more than the previous page 
  60.                 number.  
  61.  
  62.           .br - causes succeeding text to start on a new line at the 
  63.  
  64.  
  65.                                       -1-
  66.  
  67.  
  68.      NRO (1)                    CP/M Version 2.2                    NRO (1)
  69.  
  70.  
  71.                 current left margin.  There is no numeric argument for 
  72.                 this command.  
  73.  
  74.           .bs - enables or disables the appearance of backspaces in 
  75.                 the output text.  Underlining and boldface options are 
  76.                 implemented by inserting character - backspace - 
  77.                 character combinations into the output buffer.  This 
  78.                 is fine for devices which properly recognize the 
  79.                 backspace character.  Some printers, however, do not 
  80.                 recognize backspaces, so the option is provided to 
  81.                 overprint one line buffer with another.  The first 
  82.                 line buffer is terminated with just a carriage return 
  83.                 rather than the carriage return - linefeed 
  84.                 combination.  A zero argument or no argument to the 
  85.                 backspace command removes backspaces from the output.  
  86.                 A non-zero argument leaves them in the output.  The 
  87.                 default is to remove backspaces.  
  88.  
  89.                             ___                                                    .cc - changes the NRO command character to that specified by 
  90.                 the character argument.  If no argument is provided, 
  91.                 the default is a period.  
  92.  
  93.           .ce - causes the next line of text to appear centered on the 
  94.                 output.  The optional argument specifies if more than 
  95.                 one line is to be centered.  
  96.  
  97.           .de - causes all text and commands following to be used to 
  98.                                                                     en                   define a macro.  The definition is terminated by a .en 
  99.                 command.  The first two characters of the argument 
  100.                                de                                                      following the .de command become the name of the new 
  101.                 command.  It should be noted that upper and lower case 
  102.                 arguments are considered different.  Thus, the 
  103.                           PP      pp                                              commands .PP and .pp could define two different 
  104.                 macros.  Care should be exercised since existing 
  105.                 commands may be redefined.  
  106.  
  107.                 A macro may contain up to ten arguments.  In the macro 
  108.                 definition, the placement of arguments is designated 
  109.                 by the two character sequences, $0, $1, ... $9.  When 
  110.                 the macro is invoked, each argument of the macro 
  111.                 command line is substituted for its corresponding 
  112.                 designator in the expansion.  The first argument of 
  113.                 the macro command is substituted for the $0 in the 
  114.                 expansion, the second argument for the $1, and so 
  115.                 forth.  Arguments are typically strings which do not 
  116.                 contain blanks or tabs.  If an argument is to contain 
  117.                 blanks, then it should be surrounded by either single 
  118.                 or double quotes.  
  119.  
  120.           .cu - causes the next line(s) of text to be continuously 
  121.                                                                 ul                    underlined.  Unlike the underline command (see .ul) 
  122.                 which underlines only alphanumerics, continuous 
  123.                 underlining underlines all printable characters.  The 
  124.                 optional argument specifies the number of lines of 
  125.                 text to underlined.  Any normal underlining or 
  126.                 boldface commands currently in effect will be 
  127.                 terminated.  
  128.  
  129.  
  130.  
  131.                                       -2-
  132.  
  133.  
  134.      NRO (1)                    CP/M Version 2.2                    NRO (1)
  135.  
  136.  
  137.           .ef - specifies the text for the footer on even numbered 
  138.                 pages.  The format is the same as for the footer 
  139.                               fo                      command (see .fo).  
  140.  
  141.           .eh - specifies the text for the header on even numbered 
  142.                 pages.  The format is the same as for the footer 
  143.                               fo                      command (see .fo).  
  144.  
  145.           .en - designates the end of a macro definition.  
  146.  
  147.           .fi - causes the input text to be rearranged or filled to 
  148.                 obtain the maximum word count possible between the 
  149.                 previously set left and right margins.  No argument is 
  150.                 expected.  
  151.  
  152.           .fo - specifies text to be used for a footer.  The footer 
  153.                 text contains three strings seperated by a delimiter 
  154.                 character.  The first non-blank character following 
  155.                 the command is designated as the delimiter.  The first 
  156.                 text string is left justified to the current 
  157.                                                  in                                 indentation value (specified by .in).  The second 
  158.                 string is centered between the current indentation 
  159.                 value and the current right margin value (specified by 
  160.                  rm                                                                 .rm).  The third string is right justified to the 
  161.                 current right margin value.  The absence of footer 
  162.                 text will result in the footer being printed as one 
  163.                 blank line.  The presence of the page number character 
  164.                          pc                                                              (set by .pc) in the footer text results in the current 
  165.                 page number being inserted at that position.  Multiple 
  166.                 occurrances of the page number character are allowed.  
  167.  
  168.           .he - specifies text to be used for a header.  The format is 
  169.                                                  fo                      the same as for the footer (see .fo).  
  170.  
  171.           .in - indents the left margin to the column value specified 
  172.                 by the argument.  The default left margin is set to 
  173.                 zero.  
  174.  
  175.           .ju - causes blanks to be inserted between words in a line 
  176.                 of output in order to align or justify the right 
  177.                 margin.  The default is to justify.  
  178.  
  179.           .ls - sets the line spacing to the value specified by the 
  180.                 argument.  The default is for single spacing.  
  181.  
  182.           .m1 - specifies the number of lines in the header margin.  
  183.                 This is the space from the physical top of page to and 
  184.                 including the header text.  A value of zero causes the 
  185.                 header to not be printed.  A value of one causes the 
  186.                 header to appear at the physical top of page.  Larger 
  187.                 argument values cause the appropriate number of blank 
  188.                 lines to appear before the header is printed.  
  189.  
  190.           .m2 - specifies the number of blank lines to be printed 
  191.                 between the header line and the first line of the 
  192.                 processed text.  
  193.  
  194.           .m3 - specifies the number of blank lines to be printed 
  195.  
  196.  
  197.                                       -3-
  198.  
  199.  
  200.      NRO (1)                    CP/M Version 2.2                    NRO (1)
  201.  
  202.  
  203.                 between the last line of processed text and the footer 
  204.                 line.  
  205.  
  206.           .m4 - specifies the number of lines in the footer margin.  
  207.                                                                   m1                   This command affects the footer the same way the .m1 
  208.                 command affects the header.  
  209.  
  210.           .ne - specifies a number of lines which should not be broken 
  211.                 across a page boundary.  If the number of lines 
  212.                 remaining on a page is less than the value needed, 
  213.                 then a new output page is started.  
  214.  
  215.           .nf - specifies that succeeding text should be printed 
  216.                 without rearrangement, or with no fill.  No argument 
  217.                 is expected.  
  218.  
  219.           .nj - specifies that no attempt should be made to align or 
  220.                 justify the right margin.  No argument is expected.  
  221.  
  222.           .nr - causes the value of a number register to be set or 
  223.                 modified.  A total of twenty-six number registers are 
  224.                 available designated @na through @nz (either upper or 
  225.                 lower case is allowed).  When the sequence @nc is 
  226.                 imbedded in the text, the current value of number 
  227.                 register c replaces the sequence, thus, such things as 
  228.                 paragraph numbering can be accomplished with relative 
  229.                 ease.  
  230.  
  231.           .of - specifies the text for the footer on odd numbered 
  232.                 pages.  The format is the same as the footer command 
  233.                       fo                      (see .fo).  
  234.  
  235.           .oh - specifies the text for the header on odd numbered 
  236.                 pages.  The format is the same as the footer command 
  237.                       fo                      (see .fo).  
  238.  
  239.           .pc - specifies the page number character to be used in 
  240.                 headers and footers.  The occurrance of this character 
  241.                 in the header or footer text results in the current 
  242.                 page number being printed.  The default for this 
  243.                 character is the hash mark (#).  
  244.  
  245.           .pl - specifies the page lenght or the number of lines per 
  246.                 output page.  The default is sixty-six.  
  247.  
  248.           .po - specifies a page offset value.  This allows the 
  249.                 formatted text to be shifted to the right by the 
  250.                 number of spaces specified.  This feature may also be 
  251.                 invoked by a switch on the command line.  
  252.  
  253.           .rm - sets the column value for the right margin.  The 
  254.                 default is eighty.  
  255.  
  256.           .so - causes input to be retrieved from the file specified 
  257.                 by the command's character string argument.  The 
  258.                 contents of the new file are inserted into the output 
  259.                 stream until an EOF is detected.  Processing of the 
  260.                 original file is then resumed.  Command nesting is 
  261.  
  262.  
  263.                                       -4-
  264.  
  265.  
  266.      NRO (1)                    CP/M Version 2.2                    NRO (1)
  267.  
  268.  
  269.                 allowed.  
  270.  
  271.           .sp - specifies a number of blank lines to be output before 
  272.                 printing the next line of text.  
  273.  
  274.           .ti - temporarily alters the indentation or left margin 
  275.                 value for a single succeeding line of text.  
  276.  
  277.           .ul - underlines the alphanumeric text in the following 
  278.                 line(s).  The optional argument specifies the number 
  279.                 of lines to be underlined.  Underlining and boldface 
  280.                 are mutually exclusive features.  The appearance of an 
  281.                 underline command cancels any existing boldface 
  282.                 operations.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.                                       -5-
  330.  
  331.          stream until an EOF is d